File Template for Automatic Provisioning
To facilitate automatic provisioning setup, you can use a single template to define the files to download during automatic provisioning. The template uses special keywords to denote the different file types to download and in the URL address of the provisioning server it uses a placeholder for the file names which is replaced by hardcoded file names and extensions according to file type, as described in more detail below.
● | Unlike the parameters that define specific URLs for Auxiliary files (e.g., [CptFileURL]), the file template feature always retains the URLs after each automatic update process. Therefore, with the file template the device always attempts to download the files upon each automatic update process. |
● | If you configure a parameter used to define a URL for a specific file (e.g., [CptFileURL]), the settings of the [TemplateUrl] parameter is ignored for the specific file type (e.g., CPT file). |
● | Additional placeholders can be used in the file name in the URL, for example, <MAC> for MAC address (see MAC Address Placeholder in Configuration File Name). |
➢ | To use a file template for automatic provisioning: |
1. | Define the file types to download by the file template, using the [AupdFilesList] parameter. Use the keywords listed in the table below to specify each file type. For example, to specify ini, License Key, and CPT files: |
● | ini File: |
AupdFilesList = 'ini', 'fk', 'cpt'
● | CLI: |
# configure system (config-system)# automatic update (auto-update)# template-files-list ini,fk,cpt
2. | Define the URL address of the provisioning server on which the files (specified in Step 1) are located for download, using the [TemplateUrl] parameter. When you configure the URL, you must include the file type placeholder, "<FILE>", which represents the file name. For each file type specified in Step 1, the device sends an HTTP request to the server, where the placeholder in the URL is replaced with the filename and extension, as listed in the below table. For example, if you configure the [AupdFilesList] parameter as in Step 1 and the [TemplateUrl] parameter to: |
● | ini File: |
TemplateUrl = 'http://10.8.8.20/Site1_<FILE>'
● | CLI: |
# configure system (config-system)# automatic update (auto-update)# template-url http://10.8.8.20/Site1_<FILE>
The device sends HTTP requests to the following URLs:
● | http://10.8.8.20/Site1_device.ini |
● | http://10.8.8.20/Site1_fk.ini |
● | http://10.8.8.20/Site1_cpt.data |
3. | Place the files to download on the provisioning server. Make sure that their file names and extensions are based on the hardcoded string values specific to the file type for the <FILE> placeholder (e.g., "Site1_device.ini" for the ini file), as shown in the table below. |
File Template Keywords and Placeholder Values per File Type
File Type |
Keywords for Template File |
Value Replacing |
---|---|---|
ini file |
ini |
device.ini |
CLI Script file |
cli |
cliScript.txt |
CLI Startup Script file |
clis |
cliStartupScript.txt |
CMP file based on timestamp |
acmp |
autoFirmware.cmp |
User Information file |
usrinf |
userInfo.txt |
CMP file |
cmp |
firmware.cmp |
License Key file |
fk |
fk.ini |
Call Progress Tone (CPT) file |
cpt |
cpt.dat |
Prerecorded Tones (PRT) file |
prt |
prt.dat |
Dial Plan file |
dpln |
dialPlan.dat |
Answering Machine Detection (AMD) file |
amd |
amd.dat |
TLS Private Key file |
sslp |
pkey.pem pkey<ID>.pem (for multi-certificate system) |
TLS Root Certificate file |
sslr |
root.pem root<ID>.pem (for multi-certificate system) |
TLS Certificate file |
sslc |
cert.pem cert<ID>.pem (for multi-certificate system) |